GET api/account/{clientID}/orders?status[0]={status[0]}&status[1]={status[1]}&internationalStatus[0]={internationalStatus[0]}&internationalStatus[1]={internationalStatus[1]}

Retrieves a list of orders associated with a client account, filtered by domestic or international order statuses.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

The unique identifier for the client account.

 integer

Required
status

An optional collection of domestic order statuses to filter by.

 Collection of enOrderStatus

None.
internationalStatus

An optional collection of international order statuses to filter by. International orders are only available if the 'IsInternationalTradingServiceForMobileActive' profile setting is enabled.

 Collection of enInternationalOrderStatus

None.

Body Parameters

None.

Response Information

Resource Description

A list of client orders filtered by the specified statuses, if provided.

ClientOrders
NameDescriptionTypeAdditional information
ClientID

Unique client identifier.

integer

None.
ClientName

Client account name.

string

None.
ClientExternalRef

Client external reference.

string

None.
Orders

List of domestic orders.

Collection of OrderSimple

None.
InternationalOrders

List of international orders.

Collection of OrderDetails

None.

Response Formats

application/json, text/json

Sample: 
{
  "ClientID": 12345,
  "ClientName": "Sunlign Pty Ltd",
  "ClientExternalRef": "Sunderland",
  "Orders": [
    {
      "OrderID": 12345,
      "SecurityCode": "BHP",
      "Exchange": "ASX",
      "BuySell": 1,
      "Quantity": 1240,
      "QuantityBooked": 200,
      "OrderStatus": 1,
      "CreatedTimestamp": "2025-04-04T05:20:17.6136715+11:00",
      "VWAP": 18.2,
      "NettingID": 45678,
      "PriceType": 1,
      "Price": 10.0,
      "DestinationSelected": 1,
      "Creator": "Mr Jeff Joseph",
      "Origin": 12,
      "ClientBrokerageSchedule": "ASXPhoneBrokerLimit",
      "ClientBrokerageScheduleID": 57416,
      "ValidityType": 4,
      "ExpiryDate": "2025-04-04",
      "ExternalOrder": "12345",
      "QuantityFilled": 200,
      "OpenValue": 45.88,
      "MarketRef": "12345",
      "CompletedTimestamp": "2025-04-04T05:20:17.6136715+11:00",
      "NotesForClient": "ABCDEF",
      "OrderGiver": "Testing Order Giver",
      "ClientBrokerageSteps": [
        {
          "BrokerageStepID": 4,
          "MinValue": 13.6364,
          "MinValueGSTInc": 15.0,
          "RateValue": 0.0,
          "RateValueGSTInc": 0.0
        },
        {
          "BrokerageStepID": 5,
          "MinValue": 13.6364,
          "MinValueGSTInc": 15.0,
          "RateValue": 0.000909,
          "RateValueGSTInc": 0.001
        }
      ]
    },
    {
      "OrderID": 15678,
      "SecurityCode": "TLS",
      "Exchange": "ASX",
      "BuySell": 2,
      "Quantity": 850,
      "QuantityBooked": 350,
      "OrderStatus": 1,
      "CreatedTimestamp": "2025-04-04T05:20:17.6136715+11:00",
      "VWAP": 27.0,
      "NettingID": 89541,
      "PriceType": 3,
      "Price": 125.2,
      "DestinationSelected": 1,
      "Creator": "Ms Janice",
      "Origin": 14,
      "ClientBrokerageSchedule": "CustomTotalOrAdviceFee $9.0909 or 2.7273%",
      "ClientBrokerageScheduleID": 862605,
      "ValidityType": 6,
      "ExpiryDate": "2025-04-04",
      "ExternalOrder": "15678",
      "QuantityFilled": 200,
      "OpenValue": 45.88,
      "MarketRef": "12345",
      "CompletedTimestamp": "2025-04-04T05:20:17.6136715+11:00",
      "NotesForClient": "ABCDEF",
      "OrderGiver": "Testing Order Giver",
      "ClientBrokerageSteps": [
        {
          "BrokerageStepID": 559332,
          "MinValue": 9.0909,
          "MinValueGSTInc": 10.0,
          "RateValue": 0.027273,
          "RateValueGSTInc": 0.03
        }
      ]
    }
  ],
  "InternationalOrders": [
    {
      "OrderUID": "34ad23ed-803f-49ad-9066-7bd43b851082",
      "DWOrderID": "KJ.59742ce0-6e79-4df2-a3c1-6aa91ae99c80",
      "DWOrderNo": "KJXW000002",
      "Symbol": "AAPL",
      "SymbolName": "Apple",
      "Type": 1,
      "Side": 1,
      "Status": 3,
      "Price": 100.0,
      "MarketPrice": 0.0,
      "AveragePrice": 200.0,
      "AmountCash": null,
      "OrderQuantity": 1.0,
      "Quantity": 50.0,
      "CumulativeQuantity": 100.0,
      "UnfilledQuantity": 0.0,
      "TimeInForce": "GTC",
      "OrderExpires": "2025-06-22T18:20:17.6146741Z",
      "AccountExternalRefID": "f9b9b6be-706b-47e6-8a93-a8071aa3b242",
      "CreatedBy": "f9b9b6be-706b-47e6-8a93-a8071aa3b242",
      "OrderCreated": "2025-03-30T18:20:17.6146741Z",
      "OrderCompleted": null,
      "Commission": 20.0
    }
  ]
}

application/xml, text/xml

Sample: 
<ClientOrders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <ClientExternalRef>Sunderland</ClientExternalRef>
  <ClientID>12345</ClientID>
  <ClientName>Sunlign Pty Ltd</ClientName>
  <InternationalOrders xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.International">
    <d2p1:OrderDetails>
      <d2p1:AccountExternalRefID>f9b9b6be-706b-47e6-8a93-a8071aa3b242</d2p1:AccountExternalRefID>
      <d2p1:AmountCash i:nil="true" />
      <d2p1:AveragePrice>200.00</d2p1:AveragePrice>
      <d2p1:Commission>20.00</d2p1:Commission>
      <d2p1:CreatedBy>f9b9b6be-706b-47e6-8a93-a8071aa3b242</d2p1:CreatedBy>
      <d2p1:CumulativeQuantity>100.00</d2p1:CumulativeQuantity>
      <d2p1:DWOrderID>KJ.59742ce0-6e79-4df2-a3c1-6aa91ae99c80</d2p1:DWOrderID>
      <d2p1:DWOrderNo>KJXW000002</d2p1:DWOrderNo>
      <d2p1:MarketPrice>0.00</d2p1:MarketPrice>
      <d2p1:OrderCompleted i:nil="true" />
      <d2p1:OrderCreated>2025-03-30T18:20:17.6146741Z</d2p1:OrderCreated>
      <d2p1:OrderExpires>2025-06-22T18:20:17.6146741Z</d2p1:OrderExpires>
      <d2p1:OrderQuantity>1.00</d2p1:OrderQuantity>
      <d2p1:OrderUID>34ad23ed-803f-49ad-9066-7bd43b851082</d2p1:OrderUID>
      <d2p1:Price>100</d2p1:Price>
      <d2p1:Quantity>50.0</d2p1:Quantity>
      <d2p1:Side>Buy</d2p1:Side>
      <d2p1:Status>FILLED</d2p1:Status>
      <d2p1:Symbol>AAPL</d2p1:Symbol>
      <d2p1:SymbolName>Apple</d2p1:SymbolName>
      <d2p1:TimeInForce>GTC</d2p1:TimeInForce>
      <d2p1:Type>Limit</d2p1:Type>
      <d2p1:UnfilledQuantity>0.00</d2p1:UnfilledQuantity>
    </d2p1:OrderDetails>
  </InternationalOrders>
  <Orders>
    <OrderSimple>
      <BuySell>Buy</BuySell>
      <ClientBrokerageSchedule>ASXPhoneBrokerLimit</ClientBrokerageSchedule>
      <ClientBrokerageScheduleID>57416</ClientBrokerageScheduleID>
      <ClientBrokerageSteps>
        <BrokerageStep xmlns="">
          <BrokerageStepID>4</BrokerageStepID>
          <MinValue>13.6364</MinValue>
          <MinValueGSTInc>15.0000</MinValueGSTInc>
          <RateValue>0.00000000</RateValue>
          <RateValueGSTInc>0.000000</RateValueGSTInc>
        </BrokerageStep>
        <BrokerageStep xmlns="">
          <BrokerageStepID>5</BrokerageStepID>
          <MinValue>13.6364</MinValue>
          <MinValueGSTInc>15.0000</MinValueGSTInc>
          <RateValue>0.00090900</RateValue>
          <RateValueGSTInc>0.001000</RateValueGSTInc>
        </BrokerageStep>
      </ClientBrokerageSteps>
      <CompletedTimestamp>2025-04-04T05:20:17.6136715+11:00</CompletedTimestamp>
      <CreatedTimestamp>2025-04-04T05:20:17.6136715+11:00</CreatedTimestamp>
      <Creator>Mr Jeff Joseph</Creator>
      <DestinationSelected>ASX</DestinationSelected>
      <Exchange>ASX</Exchange>
      <ExpiryDate>2025-04-04T00:00:00+11:00</ExpiryDate>
      <ExternalOrder>12345</ExternalOrder>
      <MarketRef>12345</MarketRef>
      <NettingID>45678</NettingID>
      <NotesForClient>ABCDEF</NotesForClient>
      <OpenValue>45.88</OpenValue>
      <OrderGiver>Testing Order Giver</OrderGiver>
      <OrderID>12345</OrderID>
      <OrderStatus>Active</OrderStatus>
      <Origin>WebServices</Origin>
      <Price>10.00</Price>
      <PriceType>Limit</PriceType>
      <Quantity>1240</Quantity>
      <QuantityBooked>200</QuantityBooked>
      <QuantityFilled>200</QuantityFilled>
      <SecurityCode>BHP</SecurityCode>
      <VWAP>18.2</VWAP>
      <ValidityType>GoodTillExpiry</ValidityType>
    </OrderSimple>
    <OrderSimple>
      <BuySell>Sell</BuySell>
      <ClientBrokerageSchedule>CustomTotalOrAdviceFee $9.0909 or 2.7273%</ClientBrokerageSchedule>
      <ClientBrokerageScheduleID>862605</ClientBrokerageScheduleID>
      <ClientBrokerageSteps>
        <BrokerageStep xmlns="">
          <BrokerageStepID>559332</BrokerageStepID>
          <MinValue>9.0909</MinValue>
          <MinValueGSTInc>10.0000</MinValueGSTInc>
          <RateValue>0.02727300</RateValue>
          <RateValueGSTInc>0.030000</RateValueGSTInc>
        </BrokerageStep>
      </ClientBrokerageSteps>
      <CompletedTimestamp>2025-04-04T05:20:17.6136715+11:00</CompletedTimestamp>
      <CreatedTimestamp>2025-04-04T05:20:17.6136715+11:00</CreatedTimestamp>
      <Creator>Ms Janice</Creator>
      <DestinationSelected>ASX</DestinationSelected>
      <Exchange>ASX</Exchange>
      <ExpiryDate>2025-04-04T00:00:00+11:00</ExpiryDate>
      <ExternalOrder>15678</ExternalOrder>
      <MarketRef>12345</MarketRef>
      <NettingID>89541</NettingID>
      <NotesForClient>ABCDEF</NotesForClient>
      <OpenValue>45.88</OpenValue>
      <OrderGiver>Testing Order Giver</OrderGiver>
      <OrderID>15678</OrderID>
      <OrderStatus>Active</OrderStatus>
      <Origin>TPPMultiOrderPad</Origin>
      <Price>125.20</Price>
      <PriceType>MarketToLimit</PriceType>
      <Quantity>850</Quantity>
      <QuantityBooked>350</QuantityBooked>
      <QuantityFilled>200</QuantityFilled>
      <SecurityCode>TLS</SecurityCode>
      <VWAP>27</VWAP>
      <ValidityType>GoodTillCancel</ValidityType>
    </OrderSimple>
  </Orders>
</ClientOrders>

Error Response Information

Resource Description

A list of client orders filtered by the specified statuses, if provided.

string

Error Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>